Android Scanbot SDK/io.scanbot.sdk.docprocessing

Package-level declarations

Types

class DefaultDraftDocumentProcessor(documentStoreStrategy: DocumentStoreStrategy, composerFactory: ComposerFactory, documentProcessorMonitor: ProcessorMonitor<Document>) : DraftDocumentProcessor

Default implementation of DraftDocumentProcessor

DefaultPdfPagesExtractor

class DefaultPdfPagesExtractor(val pageFileStorage: PageFileStorage, fileIOProcessor: FileIOProcessor) : DefaultPdfImagesExtractor, PdfPagesExtractor

Allows to import pdf files to Scanbot SDK as pages or extract image files. Based on Android PdfRenderer.

Document

class Document

Represents a document.

DocumentApi

interface DocumentApi

Represents a Document API that allows to create, load and store documents. Please call all this methods in IO thread if possible as they performs file operations.

DocumentProcessingResult

data class DocumentProcessingResult(val document: Document, val pages: List<Page>, val documentFile: File)

Result of the document draft processing

DocumentProcessorMonitor

class DocumentProcessorMonitor(documentStoreStrategy: DocumentStoreStrategy) : ProcessorMonitor<Document>

Reacts on Document processing finished

DocumentRepository

class DocumentRepository(val storage: ResultStorage<Document>) : ResultRepository<Document>

Provides access to the scanning result of the given type by ResultId The current implementation of the repository keeps the result only in RAM and does not store anything on the persistent storage It is important to persist the data manually if it is needed to be used after the restart of the process of the application Be careful when processing the intent with ResultId in onCreate method of the Activity as it may be recreated after the termination of the process

DocumentStorage

class DocumentStorage : ResultStorage<Document>

Stores and provides access to the scanning result of the given type by ResultId This implementation uses LRU cache as a storage to keep the memory usage low even if many results will be added to the storage

DraftDocumentProcessor

interface DraftDocumentProcessor

Page

class Page

Represents a page of a document.

PdfPagesExtractor

interface PdfPagesExtractor

Allows to import pdf files to Scanbot SDK as pages or extract image files

ProcessorMonitor

interface ProcessorMonitor<T>

Reacts on T processing finished